Vapi Metadata Cli Command OptionInfo

Vapi Metadata Cli Command OptionInfo
Vapi Metadata Cli Command OptionInfo

The Vapi Metadata Cli Command OptionInfo schema describes information about a specific input option of a command.

JSON Example
{
    "long_option": "string",
    "short_option": "string",
    "field_name": "string",
    "description": "string",
    "type": "string",
    "generic": "string"
}
string
long_option
Required

The long option name of the parameter as used by the user.

string
short_option
Optional

The single character value option name.

If not present, there's no single character option for the parameter.

string
field_name
Required

The fully qualified name of the option referred to by the operation element in Vapi Metadata Cli Command Info.operation_id.

string
description
Required

The description of the option to be displayed to the user when they request usage information for a CLI command.

string
type
Required

The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumerated type this stores the fully qualified enumerated type id.

string
generic
Required

This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.

For more information see: Vapi Metadata Cli Command GenericType.

Property Of